lteiot23.h File Reference

This file contains API for LTE IoT 23 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	lteiot23_t
	LTE IoT 23 Click context object. More...
struct	lteiot23_cfg_t
	LTE IoT 23 Click configuration object. More...

Macros
#define	LTEIOT23_CMD_AT   "AT"
	LTE IoT 23 control commands.
#define	LTEIOT23_CMD_GET_MODEL_ID   "AT+CGMM"
#define	LTEIOT23_CMD_GET_SW_VERSION   "AT+CGMR"
#define	LTEIOT23_CMD_GET_SERIAL_NUM   "AT+CGSN"
#define	LTEIOT23_CMD_FACTORY_RESET   "AT&F0"
#define	LTEIOT23_CMD_SW_RESET   "ATZ"
#define	LTEIOT23_CMD_SET_UE_FUNCTIONALITY   "AT+CFUN"
#define	LTEIOT23_CMD_NETWORK_REGISTRATION   "AT+CEREG"
#define	LTEIOT23_CMD_SIGNAL_QUALITY_REPORT   "AT%CSQ"
#define	LTEIOT23_CMD_OPERATOR_SELECTION   "AT+COPS"
#define	LTEIOT23_CMD_SEND_SMS   "AT+CMGS"
#define	LTEIOT23_CMD_SELECT_SMS_FORMAT   "AT+CMGF"
#define	LTEIOT23_CMD_DEFINE_PDP_CONTEXT   "AT+CGDCONT"
#define	LTEIOT23_CMD_SHOW_PDP_ADDRESS   "AT+CGPADDR"
#define	LTEIOT23_CMD_ACTIVATE_PDP_CONTEXT   "AT+CGACT"
#define	LTEIOT23_CMD_SOCKET_CMD   "AT%SOCKETCMD"
#define	LTEIOT23_CMD_SOCKET_DATA   "AT%SOCKETDATA"
#define	LTEIOT23_CMD_SOCKET_EVENTS   "AT%SOCKETEV"
#define	LTEIOT23_RSP_OK   "OK"
	LTE IoT 23 device response for AT commands.
#define	LTEIOT23_RSP_ERROR   "ERROR"
#define	LTEIOT23_MAX_RSP_TIME_DEFAULT   500ul
	LTE IoT 23 device response time for AT commands.
#define	LTEIOT23_MAX_RSP_TIME_COPS   180000ul
#define	LTEIOT23_MAX_RSP_TIME_CFUN   15000ul
#define	LTEIOT23_MAX_RSP_TIME_CMGS   120000ul
#define	LTEIOT23_MAX_RSP_TIME_CGDCONT   5000ul
#define	LTEIOT23_MAX_RSP_TIME_URC   30000ul
#define	LTEIOT23_URC_SOCKET_DATA_EVENT   "%SOCKETEV:"
	LTE IoT 23 device unsolicited response code (URC) settings.
#define	LTEIOT23_URC_SOCKET_DATA   "%SOCKETDATA:"
#define	LTEIOT23_URC_NETWORK_REGISTERED   "+CEREG: 2,1"
#define	LTEIOT23_URC_SMS_FORMAT_PDU   "+CMGF: 0"
#define	LTEIOT23_URC_SMS_FORMAT_TXT   "+CMGF: 1"
#define	LTEIOT23_URC_BOOT_EVENT   "%BOOTEV:"
#define	LTEIOT23_POWER_STATE_OFF   0
	LTE IoT 23 power state settings.
#define	LTEIOT23_POWER_STATE_ON   1
#define	LTEIOT23_TX_DRV_BUFFER_SIZE   256
	LTE IoT 23 driver buffer size.
#define	LTEIOT23_RX_DRV_BUFFER_SIZE   256
#define	LTEIOT23_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	lteiot23_return_value_t { LTEIOT23_OK = 0 , LTEIOT23_ERROR = -1 , LTEIOT23_ERROR_TIMEOUT = -2 , LTEIOT23_ERROR_CMD = -3 }
	LTE IoT 23 Click return value data. More...

Functions
void	lteiot23_cfg_setup (lteiot23_cfg_t *cfg)
	LTE IoT 23 configuration object setup function.
err_t	lteiot23_init (lteiot23_t *ctx, lteiot23_cfg_t *cfg)
	LTE IoT 23 initialization function.
err_t	lteiot23_generic_write (lteiot23_t *ctx, uint8_t *data_in, uint16_t len)
	LTE IoT 23 data writing function.
err_t	lteiot23_generic_read (lteiot23_t *ctx, uint8_t *data_out, uint16_t len)
	LTE IoT 23 data reading function.
void	lteiot23_set_wup_pin (lteiot23_t *ctx, uint8_t state)
	LTE IoT 23 set WUP pin function.
void	lteiot23_set_rst_pin (lteiot23_t *ctx, uint8_t state)
	LTE IoT 23 set RST pin function.
void	lteiot23_set_cts_pin (lteiot23_t *ctx, uint8_t state)
	LTE IoT 23 set CTS pin function.
uint8_t	lteiot23_get_hwu_pin (lteiot23_t *ctx)
	LTE IoT 23 get HWU pin function.
uint8_t	lteiot23_get_rts_pin (lteiot23_t *ctx)
	LTE IoT 23 get RTS pin function.
void	lteiot23_set_power_state (lteiot23_t *ctx, uint8_t state)
	LTE IoT 23 set power state function.
void	lteiot23_cmd_run (lteiot23_t *ctx, uint8_t *cmd)
	LTE IoT 23 cmd run function.
void	lteiot23_cmd_set (lteiot23_t *ctx, uint8_t *cmd, uint8_t *value)
	LTE IoT 23 cmd set function.
void	lteiot23_cmd_get (lteiot23_t *ctx, uint8_t *cmd)
	LTE IoT 23 cmd get function.
void	lteiot23_cmd_help (lteiot23_t *ctx, uint8_t *cmd)
	LTE IoT 23 cmd help function.
void	lteiot23_set_sim_apn (lteiot23_t *ctx, uint8_t *sim_apn)
	LTE IoT 23 set sim card APN function.
void	lteiot23_send_sms_text (lteiot23_t *ctx, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 23 send SMS in text mode function.
err_t	lteiot23_send_sms_pdu (lteiot23_t *ctx, uint8_t *service_center_number, uint8_t *phone_number, uint8_t *sms_text)
	LTE IoT 23 send SMS in PDU mode function.

Detailed Description

This file contains API for LTE IoT 23 Click Driver.

Enumeration Type Documentation

lteiot23_return_value_t

enum lteiot23_return_value_t

LTE IoT 23 Click return value data.

Predefined enum values for driver return values.

Enumerator
LTEIOT23_OK
LTEIOT23_ERROR
LTEIOT23_ERROR_TIMEOUT
LTEIOT23_ERROR_CMD